<meta charset="utf-8">
(#) Missing `PendingIntent` mutability flag

!!! ERROR: Missing `PendingIntent` mutability flag
   This is an error, and is also enforced at build time when
   supported by the build system. For Android this means it will
   run during release builds.

Id
:   `UnspecifiedImmutableFlag`
Summary
:   Missing `PendingIntent` mutability flag
Severity
:   Fatal
Category
:   Security
Platform
:   Android
Vendor
:   Android Open Source Project
Feedback
:   https://issuetracker.google.com/issues/new?component=192708
Since
:   4.3.0-alpha01 (December 2020)
Affects
:   Kotlin and Java files
Editing
:   This check runs on the fly in the IDE editor
See
:   https://developer.android.com/about/versions/12/behavior-changes-12#pending-intent-mutability
See
:   https://goo.gle/UnspecifiedImmutableFlag
Implementation
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-checks/src/main/java/com/android/tools/lint/checks/PendingIntentMutableFlagDetector.kt)
Tests
:   [Source Code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/PendingIntentMutableFlagDetectorTest.kt)

Apps targeting Android 12 and higher must specify either
`FLAG_IMMUTABLE` or `FLAG_MUTABLE` when constructing a `PendingIntent`.

`FLAG_IMMUTABLE` is available since target SDK 23, and is almost always
the best choice. See
https://developer.android.com/guide/components/intents-filters#CreateImmutablePendingIntents
for a list of common exceptions to this rule.

!!! Tip
   This lint check has an associated quickfix available in the IDE.

(##) Example

Here is an example of lint warnings produced by this check:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~text
src/test/pkg/PendingIntentTest.java:7:Error: Missing PendingIntent
mutability flag [UnspecifiedImmutableFlag]
    PendingIntent.getActivity(null, 0, null, 0);
                                             -
src/test/pkg/PendingIntentTest.java:8:Error: Missing PendingIntent
mutability flag [UnspecifiedImmutableFlag]
    PendingIntent.getActivities(null, 0, null, 0);
                                               -
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Here is the source file referenced above:

`src/test/pkg/PendingIntentTest.java`:
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~java linenumbers
package test.pkg;

import android.app.PendingIntent;

public class PendingIntentTest {
    protected void test() {
        PendingIntent.getActivity(null, 0, null, 0);
        PendingIntent.getActivities(null, 0, null, 0);
    }
}

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can also visit the
[source code](https://cs.android.com/android-studio/platform/tools/base/+/mirror-goog-studio-main:lint/libs/lint-tests/src/test/java/com/android/tools/lint/checks/PendingIntentMutableFlagDetectorTest.kt)
for the unit tests for this check to see additional scenarios.

The above example was automatically extracted from the first unit test
found for this lint check, `PendingIntentMutableFlagDetector.testNoFlag`.
To report a problem with this extracted sample, visit
https://issuetracker.google.com/issues/new?component=192708.

(##) Suppressing

You can suppress false positives using one of the following mechanisms:

* Using a suppression annotation like this on the enclosing
  element:

  ```kt
  // Kotlin
  @Suppress("UnspecifiedImmutableFlag")
  fun method() {
     getActivity(...)
  }
  ```

  or

  ```java
  // Java
  @SuppressWarnings("UnspecifiedImmutableFlag")
  void method() {
     getActivity(...);
  }
  ```

* Using a suppression comment like this on the line above:

  ```kt
  //noinspection UnspecifiedImmutableFlag
  problematicStatement()
  ```

* Using a special `lint.xml` file in the source tree which turns off
  the check in that folder and any sub folder. A simple file might look
  like this:
  ```xml
  &lt;?xml version="1.0" encoding="UTF-8"?&gt;
  &lt;lint&gt;
      &lt;issue id="UnspecifiedImmutableFlag" severity="ignore" /&gt;
  &lt;/lint&gt;
  ```
  Instead of `ignore` you can also change the severity here, for
  example from `error` to `warning`. You can find additional
  documentation on how to filter issues by path, regular expression and
  so on
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/lintxml.md.html).

* In Gradle projects, using the DSL syntax to configure lint. For
  example, you can use something like
  ```gradle
  lintOptions {
      disable 'UnspecifiedImmutableFlag'
  }
  ```
  In Android projects this should be nested inside an `android { }`
  block.

* For manual invocations of `lint`, using the `--ignore` flag:
  ```
  $ lint --ignore UnspecifiedImmutableFlag ...`
  ```

* Last, but not least, using baselines, as discussed
  [here](https://googlesamples.github.io/android-custom-lint-rules/usage/baselines.md.html).

<!-- Markdeep: --><style class="fallback">body{visibility:hidden;white-space:pre;font-family:monospace}</style><script src="markdeep.min.js" charset="utf-8"></script><script src="https://morgan3d.github.io/markdeep/latest/markdeep.min.js" charset="utf-8"></script><script>window.alreadyProcessedMarkdeep||(document.body.style.visibility="visible")</script>